<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
<meta content="TweenMaxVars,com.greensock.data.TweenMaxVars,vars,autoAlpha,bevelFilter,bezier,bezierThrough,blurFilter,circlePath2D,colorMatrixFilter,colorTransform,data,delay,dropShadowFilter,dynamicProps,ease,endArray,frame,frameBackward,frameForward,frameLabel,glowFilter,height,hexColors,immediateRender,motionBlur,move,onComplete,onCompleteListener,onInit,onRepeat,onReverseComplete,onReverseCompleteListener,onStart,onStartListener,onUpdate,onUpdateListener,orientToBezier,overwrite,paused,physics2D,physicsProps,prop,quaternions,removeTint,repeat,repeatDelay,reversed,rotation,roundProps,runBackwards,scale,scaleX,scaleY,scrollRect,setSize,shortRotation,soundTransform,stageQuality,startAt,throwProps,timeScale,tint,transformAroundCenter,transformAroundPoint,transformMatrix,useFrames,visible,volume,width,x,y,yoyo" name="keywords">
<title>com.greensock.data.TweenMaxVars</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'TweenMaxVars - API Documentation';
				var baseRef = '../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">API Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?com/greensock/data/TweenMaxVars.html&amp;com/greensock/data/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;TweenMaxVars</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class TweenMaxVars"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.greensock.data</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class TweenMaxVars</td>
</tr>
</table>
<p></p>
  There are 3 primary benefits of using a TweenMaxVars instance to define your TweenMax's "vars" parameter:
  <ol>
  <li> In most code editors, code hinting will be activated which helps remind you which special properties are available.</li>
  <li> It allows you to code using strict data typing which can improve debugging.</li>
   <li> It will trace() a warning if you forgot to activate a particular plugin. For example, if you define an autoAlpha value in a TweenMaxVars instance but you didn't activate() the plugin, you'll see a trace() output when you test/compile the file (an Error isn't thrown because in some very rare circumstances it can be perfectly legitimate to avoid activating the plugin)</li>
  </ol>
 
 The down side, of course, is that the code is more verbose and TweenMaxVars adds about 5kb to your published swf. <br /><br />
  <b>USAGE:</b><br />
 Note that each method returns the TweenMaxVars object, so you can reduce the lines of code by method chaining (see example below).<br /><br />
 
 <b>Without TweenMaxVars:</b><br />
 <code>TweenMax.to(mc, 1, {x:300, y:100, tint:0xFF0000, onComplete:myFunction, onCompleteParams:[mc]})</code><br /><br />
 
 <b>With TweenMaxVars</b><br />
 <code>TweenMax.to(mc, 1, new TweenMaxVars().move(300, 100).tint(0xFF0000).onComplete(myFunction, [mc]));</code><br /><br />
  You can use the prop() method to set individual generic properties (like "myCustomProperty" or "rotationY") or you can 
 pass a generic Object into the constructor to make it a bit more concise, like this:<br /><br />
 
 <code>TweenMax.to(mc, 1, new TweenMaxVars({myCustomProperty:300, rotationY:100}).tint(0xFF0000).onComplete(myFunction, [mc]));</code><br /><br />
 
 <b>NOTES:</b><br />
 <ul>
 <li> To get the generic vars object that TweenMaxVars builds internally, simply access its "vars" property.
    In fact, if you want maximum backwards compatibility, you can tack ".vars" onto the end of your chain like this:<br /><code>
    TweenMax.to(mc, 1, new TweenMaxVars({x:300, y:100}).tint(0xFF0000).onComplete(myFunction, [mc]).vars);</code></li>
 <li> This class adds about 5.5kb to your published SWF (not including TweenMax or any plugins).</li>
 <li> Using TweenMaxVars is completely optional. If you prefer the shorter generic object synatax, feel
     free to use it. The purpose of this utility is simply to enable code hinting and to allow for strict datatyping.</li>
 </ul>
 
 <b>Copyright 2011, GreenSock. All rights reserved.</b> This work is subject to the terms in <a href="http://www.greensock.com/terms_of_use.html">http://www.greensock.com/terms_of_use.html</a> or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.
 
 <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#vars">vars</a> : Object<div class="summaryTableDescription">[read-only] The generic object populated by all of the method calls in the TweenMaxVars instance.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#TweenMaxVars()">TweenMaxVars</a>(vars:Object = null)</div>
<div class="summaryTableDescription">
   Constructor
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#autoAlpha()">autoAlpha</a>(alpha:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Same as changing the "alpha" property but with the additional feature of toggling the "visible" property to false whenever alpha is 0, thus improving rendering performance in the Flash Player.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#bevelFilter()">bevelFilter</a>(distance:Number = 4, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 0.5, shadowColor:uint = 0x000000, shadowAlpha:Number = 0.5, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens a BevelFilter
   
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#bezier()">bezier</a>(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Bezier tweening allows you to tween in a non-linear way.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#bezierThrough()">bezierThrough</a>(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Identical to bezier except that instead of passing Bezier control point values, you pass values through 
   which the Bezier values should move.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#blurFilter()">blurFilter</a>(blurX:Number, blurY:Number, quality:int = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens a BlurFilter
   
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#circlePath2D()">circlePath2D</a>(path:<a href="../motionPaths/MotionPath.html">MotionPath</a>, startAngle:Number, endAngle:Number, autoRotate:Boolean = false, direction:String = "clockwise", extraRevolutions:uint = 0, rotationOffset:Number = 0, useRadians:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens an object along a CirclePath2D motion path in any direction (clockwise, counter-clockwise, or shortest).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#colorMatrixFilter()">colorMatrixFilter</a>(colorize:uint = 0xFFFFFF, amount:Number = 1, saturation:Number = 1, contrast:Number = 1, brightness:Number = 1, hue:Number = 0, threshold:Number = -1, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   ColorMatrixFilter tweening offers an easy way to tween a DisplayObject's saturation, hue, contrast,
   brightness, and colorization.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#colorTransform()">colorTransform</a>(tint:Number, tintAmount:Number, exposure:Number, brightness:Number, redMultiplier:Number, greenMultiplier:Number, blueMultiplier:Number, alphaMultiplier:Number, redOffset:Number, greenOffset:Number, blueOffset:Number, alphaOffset:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens ColorTransform properties of a DisplayObject to do advanced effects like overexposing, altering
   the brightness or setting the percent/amount of tint.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#data()">data</a>(data:*):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Any generic data that you'd like associated with your tween.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#delay()">delay</a>(delay:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> The number of seconds (or frames for frames-based tweens) to delay before the tween begins.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#dropShadowFilter()">dropShadowFilter</a>(distance:Number = 4, blurX:Number = 4, blurY:Number = 4, alpha:Number = 1, angle:Number = 45, color:uint = 0x000000, strength:Number = 2, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false, quality:uint = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens a DropShadowFilter.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#dynamicProps()">dynamicProps</a>(props:Object, params:Object = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   If you'd like to tween something to a destination value that may change at any time,
   dynamicProps allows you to simply associate a function with a property so that
   every time the tween is rendered, it calls that function to get the new destination value 
   for the associated property.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#ease()">ease</a>(ease:Function, easeParams:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Controls the rate of change.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#endArray()">endArray</a>(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> An Array containing numeric end values of the target Array.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#frame()">frame</a>(value:int, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Tweens a MovieClip to a particular frame.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#frameBackward()">frameBackward</a>(frame:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Tweens a MovieClip backward to a particular frame number, wrapping it if/when it reaches the beginning
   of the timeline.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#frameForward()">frameForward</a>(frame:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Tweens a MovieClip forward to a particular frame number, wrapping it if/when it reaches the end
   of the timeline.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#frameLabel()">frameLabel</a>(label:String):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens a MovieClip to a particular frame.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#glowFilter()">glowFilter</a>(blurX:Number = 10, blurY:Number = 10, color:uint = 0xFFFFFF, alpha:Number = 1, strength:Number = 2, inner:Boolean = false, knockout:Boolean = false, quality:uint = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens a GlowFilter
   
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#height()">height</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "height" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hexColors()">hexColors</a>(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Although hex colors are technically numbers, if you try to tween them conventionally, 
   you'll notice that they don't tween smoothly.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#immediateRender()">immediateRender</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Normally when you create a tween, it begins rendering on the very next frame (when 
   the Flash Player dispatches an ENTER_FRAME event) unless you specify a <code>delay</code>.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#motionBlur()">motionBlur</a>(strength:Number = 1, fastMode:Boolean = false, quality:int = 2, padding:int = 10):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   MotionBlurPlugin provides an easy way to apply a directional blur to a DisplayObject based on its velocity
   and angle of movement in 2D (x/y).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#move()">move</a>(x:Number, y:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "x" and "y" properties of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onComplete()">onComplete</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function that should be called when the tween has completed.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onCompleteListener()">onCompleteListener</a>(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> A function to which the TweenMax instance should dispatch a TweenEvent when it completes.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onInit()">onInit</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function that should be called just before the tween inits (renders for the first time).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onRepeat()">onRepeat</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function that should be called every time the tween repeats 
   
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onReverseComplete()">onReverseComplete</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function that should be called when the tween has reached its starting point again after having been reversed.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onReverseCompleteListener()">onReverseCompleteListener</a>(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">  A function to which the TweenMax instance should dispatch a TweenEvent when it has reached its starting point again after having been reversed </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onStart()">onStart</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function that should be called when the tween begins (when its currentTime is at 0 
   and changes to some other value which can happen more than once if the tween is restarted multiple times).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onStartListener()">onStartListener</a>(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> A function to which the TweenMax instance should dispatch a TweenEvent when it begins.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onUpdate()">onUpdate</a>(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   A function to call whenever the tweening values are updated (on every frame during the time the tween is active).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#onUpdateListener()">onUpdateListener</a>(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#orientToBezier()">orientToBezier</a>(values:Object = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   A common effect that designers/developers want is for a MovieClip/Sprite to orient itself in the direction of 
   a Bezier path (alter its rotation).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#overwrite()">overwrite</a>(value:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Controls how (and if) other tweens of the same target are overwritten by this tween; 
   NONE = 0, ALL_IMMEDIATE = 1, AUTO = 2, CONCURRENT = 3, ALL_ONSTART = 4, PREEXISTING = 5 
   (2 through 5 are only available with the optional OverwriteManager add-on class.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#paused()">paused</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Controls the paused state of the tween - if true, the tween will be paused initially.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#physics2D()">physics2D</a>(velocity:Number, angle:Number, acceleration:Number = 0, accelerationAngle:Number = 90, friction:Number = 0):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Provides simple physics functionality for tweening a DisplayObject's x and y coordinates based on a
   combination of velocity, angle, gravity, acceleration, accelerationAngle, and/or friction.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#physicsProps()">physicsProps</a>(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Sometimes you want to tween a property (or several) but you don't have a specific end value in mind - instead,
   you'd rather describe the movement in terms of physics concepts, like velocity, acceleration, 
   and/or friction.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#prop()">prop</a>(property:String, value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Adds a dynamic property for tweening and allows you to indicate whether the value is relative or not.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#quaternions()">quaternions</a>(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> An object with properties that correspond to the quaternion properties of the target object.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeTint()">removeTint</a>(remove:Boolean = true):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Removes the tint of a DisplayObject over time.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#repeat()">repeat</a>(value:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Number of times that the tween should repeat (to repeat indefinitely, use -1).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#repeatDelay()">repeatDelay</a>(value:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Amount of time in seconds (or frames for frames-based tween) between repeats.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#reversed()">reversed</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   If true, the tween will be reversed initially.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#rotation()">rotation</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "rotation" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#roundProps()">roundProps</a>(propertyNames:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> An array of the names of properties that should be rounded to the nearest integer when tweening.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#runBackwards()">runBackwards</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> When true, the tween will flip the start and end values which is exactly what <code>TweenMax.from()</code> does.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#scale()">scale</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "scaleX" and "scaleY" properties of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#scaleX()">scaleX</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "scaleX" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#scaleY()">scaleY</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "scaleY" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#scrollRect()">scrollRect</a>(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Tweens the scrollRect property of a DisplayObject.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#setSize()">setSize</a>(width:Number, height:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Some components require resizing with setSize() instead of standard tweens of width/height in
   order to scale properly.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#shortRotation()">shortRotation</a>(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   To tween any rotation property of the target object in the shortest direction, use "shortRotation" 
   For example, if <code>myObject.rotation</code> is currently 170 degrees and you want to tween it to 
   -170 degrees, a normal rotation tween would travel a total of 340 degrees in the counter-clockwise 
   direction, but if you use shortRotation, it would travel 20 degrees in the clockwise direction instead.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#soundTransform()">soundTransform</a>(volume:Number = 1, pan:Number = 0, leftToLeft:Number = 1, leftToRight:Number = 0, rightToLeft:Number = 0, rightToRight:Number = 1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Tweens properties of an object's soundTransform property (like the volume, pan, leftToRight, etc.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#stageQuality()">stageQuality</a>(stage:Stage, during:String = "medium", after:String = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   Sets the stage's <code>quality</code> to a particular value during a tween and another value after
   the tween which can be useful for improving rendering performance in the Flash Player while things are animating.<br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.StageQualityPlugin; <br />
     import flash.display.StageQuality; <br />
     TweenPlugin.activate([StageQualityPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().prop("x", 100).stageQuality(this.stage, StageQuality.LOW, StageQuality.HIGH)); <br /><br />
   </code>
   
   </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#startAt()">startAt</a>(vars:<a href="TweenMaxVars.html">TweenMaxVars</a>):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Allows you to define the starting values for properties.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#throwProps()">throwProps</a>(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
  Allows you to define an initial velocity at which a property (or multiple properties) will start tweening, 
  as well as [optional] maximum and/or minimum end values and then it will calculate the appropriate landing 
  position and plot a smooth course to it based on the easing equation you define (Quad.easeOut by default, 
  as set in TweenLite).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#timeScale()">timeScale</a>(value:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Multiplier affecting the speed of the timeline where 1 is normal speed, 0.5 is half-speed, 2 is double speed, etc.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#tint()">tint</a>(color:uint):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   To change a DisplayObject's tint, set this to the hex value of the color you'd like the DisplayObject 
   to end up at (or begin at if you're using TweenMax.from()).</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#transformAroundCenter()">transformAroundCenter</a>(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration
   point (most often its upper left corner), but TransformAroundCenter allows you to make the transformations
   occur around the DisplayObject's center.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#transformAroundPoint()">transformAroundPoint</a>(point:Point, props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration
   point (most often its upper left corner), but TransformAroundPoint allows you to define ANY point around which
   transformations will occur during the tween.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#transformMatrix()">transformMatrix</a>(properties:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription">
   transformMatrix tweens a DisplayObject's transform.matrix values directly either using
   the standard matrix properties (<code>a, b, c, d, tx, and ty</code>) or common properties 
   like <code>x, y, scaleX, scaleY, skewX, skewY, rotation</code> and even <code>shortRotation</code>.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#useFrames()">useFrames</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   If <code>useFrames</code> is set to true, the tweens's timing mode will be based on frames.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#visible()">visible</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Sets a DisplayObject's "visible" property at the end of the tween.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#volume()">volume</a>(volume:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Changes the volume of any object that has a soundTransform property (MovieClip, SoundChannel, NetStream, etc.) </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#width()">width</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "width" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#x()">x</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "x" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#y()">y</a>(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> Tweens the "y" property of the target </div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#yoyo()">yoyo</a>(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a>
</div>
<div class="summaryTableDescription"> 
   Works in conjunction with the <code>repeat</code> property, determining the behavior of each 
   cycle.</div>
</td><td class="summaryTableOwnerCol">TweenMaxVars</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="vars"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">vars</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>vars:Object</code>&nbsp;&nbsp;[read-only]<p> The generic object populated by all of the method calls in the TweenMaxVars instance. This is the raw data that gets passed to the tween. </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get vars():Object</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="TweenMaxVars()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">TweenMaxVars</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function TweenMaxVars(vars:Object = null)</code><p>
   Constructor
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">vars</span>:Object</code> (default = <code>null</code>)<code></code> &mdash; A generic Object containing properties that you'd like added (copied) to this TweenMaxVars instance. This is particularly useful for generic properties that don't have a corresponding method for setting the values (although you can use it for properties that do have corresponding methods too). For example, to tween the x and y properties of a DisplayObject, <code>new TweenMaxVars({x:300, y:0})</code>
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="autoAlpha()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">autoAlpha</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function autoAlpha(alpha:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Same as changing the "alpha" property but with the additional feature of toggling the "visible" property to false whenever alpha is 0, thus improving rendering performance in the Flash Player. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">alpha</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="bevelFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bevelFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function bevelFilter(distance:Number = 4, angle:Number = 45, highlightColor:uint = 0xFFFFFF, highlightAlpha:Number = 0.5, shadowColor:uint = 0x000000, shadowAlpha:Number = 0.5, blurX:Number = 4, blurY:Number = 4, strength:Number = 1, quality:int = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens a BevelFilter
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">distance</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The offset distance of the bevel.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">angle</span>:Number</code> (default = <code>45</code>)<code></code> &mdash; The angle of the bevel.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">highlightColor</span>:uint</code> (default = <code>0xFFFFFF</code>)<code></code> &mdash; The highlight color of the bevel.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">highlightAlpha</span>:Number</code> (default = <code>0.5</code>)<code></code> &mdash; The alpha transparency value of the highlight color.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">shadowColor</span>:uint</code> (default = <code>0x000000</code>)<code></code> &mdash; The shadow color of the bevel.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">shadowAlpha</span>:Number</code> (default = <code>0.5</code>)<code></code> &mdash; The alpha transparency value of the shadow color.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurX</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The amount of horizontal blur, in pixels.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurY</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The amount of vertical blur, in pixels.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">strength</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; The strength of the imprint or spread.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">quality</span>:int</code> (default = <code>2</code>)<code></code> &mdash; The number of times to apply the filter.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, the filter will be removed as soon as the tween completes
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">addFilter</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, a new BevelFilter will be added to the target even if a BevelFilter is already in its filters array.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Allows you to target a particular BevelFilter if there are multiple BevelFilters in the target's filters array - simply define the index value corresponding to the BevelFilter's position in the filters array.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="bezier()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bezier</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function bezier(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Bezier tweening allows you to tween in a non-linear way. For example, you may want to tween
   a MovieClip's position from the origin (0,0) 500 pixels to the right (500,0) but curve downwards
   through the middle of the tween. Simply pass as many objects in the bezier Array as you'd like, 
   one for each "control point" (see documentation on Flash's curveTo() drawing method for more
   about how control points work).<br /><br />
   
   Keep in mind that you can bezier tween ANY properties, not just x/y. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br /><br />
   
     TweenMax.to(mc, 3, new TweenMaxVars().bezier([{x:250, y:50}, {x:500, y:0}])); //makes my_mc travel through 250,50 and end up at 500,0. <br /><br />
   </code>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Array</code> &mdash; An array of objects with key/value pairs that define the bezier points like <code>[{x:250, y:50}, {x:500, y:0}]</code>
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#bezierThrough()" target="">bezierThrough()</a>
</div>
</div>
<a name="bezierThrough()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">bezierThrough</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function bezierThrough(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Identical to bezier except that instead of passing Bezier control point values, you pass values through 
   which the Bezier values should move. This can be more intuitive than using control points. 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Array</code> &mdash; An array of objects with key/value pairs that define the bezier points like <code>[{x:250, y:50}, {x:500, y:0}]</code>
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#bezier()" target="">bezier()</a>
</div>
</div>
<a name="blurFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">blurFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function blurFilter(blurX:Number, blurY:Number, quality:int = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens a BlurFilter
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">blurX</span>:Number</code> &mdash; The amount of horizontal blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurY</span>:Number</code> &mdash; The amount of vertical blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">quality</span>:int</code> (default = <code>2</code>)<code></code> &mdash; The number of times to perform the blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, the filter will be removed as soon as the tween completes
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">addFilter</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, a new BlurFilter will be added to the target even if a BlurFilter is already in its filters array.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Allows you to target a particular BlurFilter if there are multiple BlurFilters in the target's filters array - simply define the index value corresponding to the BlurFilter's position in the filters array.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="circlePath2D()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">circlePath2D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function circlePath2D(path:<a href="../motionPaths/MotionPath.html">MotionPath</a>, startAngle:Number, endAngle:Number, autoRotate:Boolean = false, direction:String = "clockwise", extraRevolutions:uint = 0, rotationOffset:Number = 0, useRadians:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens an object along a CirclePath2D motion path in any direction (clockwise, counter-clockwise, or shortest). <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.*; <br />
     import com.greensock.motionPaths.*<br />
     TweenPlugin.activate([CirclePath2DPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     var circle:CirclePath2D = new CirclePath2D(150, 150, 100);
     TweenMax.to(mc, 2, new TweenMaxVars().circlePath2D(circle, 90, 270, false, Direction.CLOCKWISE, 2)); <br /><br />
   </code>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">path</span>:<a href="../motionPaths/MotionPath.html">MotionPath</a></code> &mdash; The CirclePath2D instance to follow (<code>com.greensock.motionPaths.CirclePath2D</code>)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">startAngle</span>:Number</code> &mdash; The position at which the target should begin its rotation (described in degrees unless useRadians is true in which case it is described in radians). For example, to begin at the top of the circle, use 270 or -90 as the startAngle.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">endAngle</span>:Number</code> &mdash; The position at which the target should end its rotation (described in degrees unless useRadians is true in which case it is described in radians). For example, to end at the bottom of the circle, use 90 as the endAngle.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">autoRotate</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; When <code>autoRotate</code> is <code>true</code>, the target will automatically be rotated so that it is oriented to the angle of the path. To offset this value (like to always add 90 degrees for example), use the <code>rotationOffset</code> property.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">direction</span>:String</code> (default = "<code>clockwise</code>")<code></code> &mdash; The direction in which the target should travel around the path. Options are <code>Direction.CLOCKWISE</code> ("clockwise"), <code>Direction.COUNTER_CLOCKWISE</code> ("counterClockwise"), or <code>Direction.SHORTEST</code> ("shortest").
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">extraRevolutions</span>:uint</code> (default = <code>0</code>)<code></code> &mdash; If instead of going directly to the endAngle, you want the target to travel one or more extra revolutions around the path before going to the endAngle, define that number of revolutions here.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rotationOffset</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; When <code>autoRotate</code> is <code>true</code>, this value will always be added to the resulting <code>rotation</code> of the target.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">useRadians</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If you prefer to define values in radians instead of degrees, set <code>useRadians</code> to true.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="colorMatrixFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">colorMatrixFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function colorMatrixFilter(colorize:uint = 0xFFFFFF, amount:Number = 1, saturation:Number = 1, contrast:Number = 1, brightness:Number = 1, hue:Number = 0, threshold:Number = -1, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   ColorMatrixFilter tweening offers an easy way to tween a DisplayObject's saturation, hue, contrast,
   brightness, and colorization. 
   
   <b>HINT</b>: If you'd like to match the ColorMatrixFilter values you created in the Flash IDE on a particular object, 
   you can get its matrix like this:<br /><br /><code>
   
    import flash.display.DisplayObject; <br />
    import flash.filters.ColorMatrixFilter; <br /><br />
    
    function getColorMatrix(mc:DisplayObject):Array { <br />
       var f:Array = mc.filters, i:uint; <br />
       for (i = 0; i &lt; f.length; i++) { <br />
          if (f[i] is ColorMatrixFilter) { <br />
             return f[i].matrix; <br />
          } <br />
       } <br />
       return null; <br />
    } <br /><br />
     
    var myOriginalMatrix:Array = getColorMatrix(my_mc); //store it so you can tween back to it anytime
   </code><br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().colorMatrixFilter(0xFF0000)); <br /><br />
   </code>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">colorize</span>:uint</code> (default = <code>0xFFFFFF</code>)<code></code> &mdash; The color to use for the colorizing effect - colorizing a DisplayObject makes it look as though you're seeing it through a colored piece of glass whereas tinting it makes every pixel exactly that color. You can control the amount of colorization using the "amount" parameter where 1 is full strength, 0.5 is half-strength, and 0 has no colorization effect.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">amount</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A number between 0 and 1 that determines the potency of the colorize effect. This parameter is ignored if the <code>colorize</code> parameter is left at its default value of 0xFFFFFF.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">saturation</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A number indicating the saturation where 1 is normal saturation, 0 makes the target look grayscale, and 2 would be double the normal saturation.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">contrast</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A number indicating the contrast where 1 is normal contrast, 0 is no contrast, and 2 is double the normal contrast, etc.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">brightness</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A number indicating the brightness where 1 is normal brightness, 0 is much darker than normal, and 2 is twice the normal brightness, etc.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">hue</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; An angle-like number between 0 and 360 indicating the change in hue. Think of it as degrees, so 180 would be rotating the hue to be exactly opposite as normal, 360 would be the same as 0, etc.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">threshold</span>:Number</code> (default = <code>-1</code>)<code></code> &mdash; A number from 0 to 255 that controls the threshold of where the pixels turn white or black (leave as -1 to avoid any threshold effect whatsoever).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, the filter will be removed as soon as the tween completes
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">addFilter</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, a new ColorMatrixFilter will be added to the target even if a ColorMatrixFilter is already in its filters array.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Allows you to target a particular ColorMatrixFilter if there are multiple ColorMatrixFilters in the target's filters array - simply define the index value corresponding to the ColorMatrixFilter's position in the filters array.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="colorTransform()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">colorTransform</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function colorTransform(tint:Number, tintAmount:Number, exposure:Number, brightness:Number, redMultiplier:Number, greenMultiplier:Number, blueMultiplier:Number, alphaMultiplier:Number, redOffset:Number, greenOffset:Number, blueOffset:Number, alphaOffset:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens ColorTransform properties of a DisplayObject to do advanced effects like overexposing, altering
   the brightness or setting the percent/amount of tint. 
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">tint</span>:Number</code> &mdash; The color value for a ColorTransform object.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">tintAmount</span>:Number</code> &mdash; A numeric value between 0 and 1 indicating the potency of the tint. For example, if tint is 0xFF0000 and tintAmount is 0.5, the target would be tinted halfway to red.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">exposure</span>:Number</code> &mdash; A numeric value between 0 and 2 where 1 is normal exposure, 0, is completely underexposed, and 2 is completely overexposed. Overexposing an object is different then changing the brightness - it seems to almost bleach the image and looks more dynamic and interesting (subjectively speaking).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">brightness</span>:Number</code> &mdash; A numeric value between 0 and 2 where 1 is normal brightness, 0 is completely dark/black, and 2 is completely bright/white
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">redMultiplier</span>:Number</code> &mdash; A decimal value that is multiplied with the red channel value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">greenMultiplier</span>:Number</code> &mdash; A decimal value that is multiplied with the green channel value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blueMultiplier</span>:Number</code> &mdash; A decimal value that is multiplied with the blue channel value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">alphaMultiplier</span>:Number</code> &mdash; A decimal value that is multiplied with the alpha transparency channel value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">redOffset</span>:Number</code> &mdash; A number from -255 to 255 that is added to the red channel value after it has been multiplied by the redMultiplier value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">greenOffset</span>:Number</code> &mdash; A number from -255 to 255 that is added to the green channel value after it has been multiplied by the greenMultiplier value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blueOffset</span>:Number</code> &mdash; A number from -255 to 255 that is added to the blue channel value after it has been multiplied by the blueMultiplier value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">alphaOffset</span>:Number</code> &mdash; A number from -255 to 255 that is added to the alpha transparency channel value after it has been multiplied by the alphaMultiplier value.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="data()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">data</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function data(data:*):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Any generic data that you'd like associated with your tween. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">data</span>:*</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="delay()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">delay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function delay(delay:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> The number of seconds (or frames for frames-based tweens) to delay before the tween begins. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">delay</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="dropShadowFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dropShadowFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function dropShadowFilter(distance:Number = 4, blurX:Number = 4, blurY:Number = 4, alpha:Number = 1, angle:Number = 45, color:uint = 0x000000, strength:Number = 2, inner:Boolean = false, knockout:Boolean = false, hideObject:Boolean = false, quality:uint = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens a DropShadowFilter.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">distance</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The offset distance for the shadow, in pixels.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurX</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The amount of horizontal blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurY</span>:Number</code> (default = <code>4</code>)<code></code> &mdash; The amount of vertical blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">alpha</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; The alpha transparency value for the shadow color.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">angle</span>:Number</code> (default = <code>45</code>)<code></code> &mdash; The angle of the shadow.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">color</span>:uint</code> (default = <code>0x000000</code>)<code></code> &mdash; The color of the shadow.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">strength</span>:Number</code> (default = <code>2</code>)<code></code> &mdash; The strength of the imprint or spread.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">inner</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Indicates whether or not the shadow is an inner shadow.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">knockout</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">hideObject</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Indicates whether or not the object is hidden.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">quality</span>:uint</code> (default = <code>2</code>)<code></code> &mdash; The number of times to apply the filter.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, the filter will be removed as soon as the tween completes
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">addFilter</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, a new DropShadowFilter will be added to the target even if a DropShadowFilter is already in its filters array.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Allows you to target a particular DropShadowFilter if there are multiple DropShadowFilters in the target's filters array - simply define the index value corresponding to the DropShadowFilter's position in the filters array.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="dynamicProps()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">dynamicProps</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function dynamicProps(props:Object, params:Object = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   If you'd like to tween something to a destination value that may change at any time,
   dynamicProps allows you to simply associate a function with a property so that
   every time the tween is rendered, it calls that function to get the new destination value 
   for the associated property. For example, if you want a MovieClip to tween to wherever the
   mouse happens to be, you could do:<br /><br /><code>
    
    TweenMax.to(mc, 3, new TweenMaxVars().dynamicProps({x:getMouseX, y:getMouseY})); <br />
    function getMouseX():Number {<br />
     return this.mouseX;<br />
    }<br />
    function getMouseY():Number {<br />
     return this.mouseY;<br />
    }<br /><br /></code>
    
   Of course you can get as complex as you want inside your custom function, as long as
   it returns the destination value, TweenLite/Max will take care of adjusting things 
   on the fly.<br /><br />
   
   You can optionally pass any number of parameters to functions using the "params" 
   parameter like so:<br /><br /><code>
   
   TweenMax.to(mc, 3, new TweenMaxVars().dynamicProps({x:myFunction, y:myFunction}, {x:[mc2, "x"], y:[mc2, "y"]})); <br />
    function myFunction(object:MovieClip, propName:String):Number {<br />
     return object[propName];<br />
    }<br /><br /></code>
   
   DynamicPropsPlugin is a <a href="http://www.greensock.com/club/">Club GreenSock</a> membership benefit. 
   You must have a valid membership to use this class without violating the terms of use. 
   Visit <a href="http://www.greensock.com/club/">http://www.greensock.com/club/</a> to sign up or get 
   more details. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.*; <br />
     TweenPlugin.activate([DynamicPropsPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(my_mc, 3, new TweenMaxVars().dynamicProps({x:getMouseX, y:getMouseY})); <br /><br />
      
     function getMouseX():Number {<br />
      return this.mouseX;<br />
     }<br />
     function getMouseY():Number {<br />
      return this.mouseY;<br />
     } <br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Object</code> (default = <code>null</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="ease()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">ease</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function ease(ease:Function, easeParams:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Controls the rate of change. Use any standard easing equation like <code>Elastic.easeOut</code>. The Default is <code>Quad.easeOut</code>.
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">ease</span>:Function</code> &mdash; An easing function (i.e. <code>com.greensock.easing.Elastic.easeOut</code>) The default is <code>Quad.easeOut</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">easeParams</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of extra parameter values to feed the easing equation (beyond the standard 4). This can be useful with easing equations like Elastic that accept extra parameters like the amplitude and period. Most easing equations, however, don't accept extra parameters so you won't need to pass in any easeParams.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="endArray()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">endArray</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function endArray(values:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> An Array containing numeric end values of the target Array. Keep in mind that the target of the tween must be an Array with at least the same length as the endArray. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Array</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="frame()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">frame</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function frame(value:int, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Tweens a MovieClip to a particular frame. 
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().frame(125)); <br /><br />
   </code>
   
   Note: When tweening the frames of a MovieClip, any audio that is embedded on the MovieClip's timeline (as "stream") will not be played. 
   Doing so would be impossible because the tween might speed up or slow down the MovieClip to any degree.<br /><br />
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:int</code> &mdash; The frame to which the MovieClip should be tweened (or if <code>relative</code> is <code>true</code>, this value would represent the number of frames to travel from the current frame)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If <code>true</code>, the frame value will be interpreted as relative to the current frame. So for example, if the MovieClip is at frame 5 currently and <code>frame(10, true) is used, the MovieClip will tween 10 frames and end up on frame 15.</code>
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="frameBackward()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">frameBackward</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function frameBackward(frame:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Tweens a MovieClip backward to a particular frame number, wrapping it if/when it reaches the beginning
   of the timeline. For example, if your MovieClip has 20 frames total and it is currently at frame 10
   and you want tween to frame 15, a normal frame tween would go forward from 10 to 15, but a frameBackward
   would go from 10 to 1 (the beginning) and wrap to the end and continue tweening from 20 to 15.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">frame</span>:int</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="frameForward()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">frameForward</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function frameForward(frame:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Tweens a MovieClip forward to a particular frame number, wrapping it if/when it reaches the end
   of the timeline. For example, if your MovieClip has 20 frames total and it is currently at frame 10
   and you want tween to frame 5, a normal frame tween would go backwards from 10 to 5, but a frameForward
   would go from 10 to 20 (the end) and wrap to the beginning and continue tweening from 1 to 5. 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">frame</span>:int</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="frameLabel()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">frameLabel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function frameLabel(label:String):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens a MovieClip to a particular frame. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">label</span>:String</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="glowFilter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">glowFilter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function glowFilter(blurX:Number = 10, blurY:Number = 10, color:uint = 0xFFFFFF, alpha:Number = 1, strength:Number = 2, inner:Boolean = false, knockout:Boolean = false, quality:uint = 2, remove:Boolean = false, addFilter:Boolean = false, index:int = -1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens a GlowFilter
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">blurX</span>:Number</code> (default = <code>10</code>)<code></code> &mdash; The amount of horizontal blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">blurY</span>:Number</code> (default = <code>10</code>)<code></code> &mdash; The amount of vertical blur.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">color</span>:uint</code> (default = <code>0xFFFFFF</code>)<code></code> &mdash; The color of the glow.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">alpha</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; The alpha transparency value for the color.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">strength</span>:Number</code> (default = <code>2</code>)<code></code> &mdash; The strength of the imprint or spread.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">inner</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the glow is an inner glow.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">knockout</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Specifies whether the object has a knockout effect.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">quality</span>:uint</code> (default = <code>2</code>)<code></code> &mdash; The number of times to apply the filter.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, the filter will be removed as soon as the tween completes
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">addFilter</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If true, a new GlowFilter will be added to the target even if a GlowFilter is already in its filters array.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">index</span>:int</code> (default = <code>-1</code>)<code></code> &mdash; Allows you to target a particular GlowFilter if there are multiple GlowFilters in the target's filters array - simply define the index value corresponding to the GlowFilter's position in the filters array.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="height()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">height</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function height(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "height" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="hexColors()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hexColors</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function hexColors(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Although hex colors are technically numbers, if you try to tween them conventionally, 
   you'll notice that they don't tween smoothly. To tween them properly, the red, green, and 
   blue components must be extracted and tweened independently. The HexColorsPlugin makes it easy. 
   To tween a property of your object that's a hex color to another hex color, just pass a hexColors 
   Object with properties named the same as your object's hex color properties. For example, 
   if myObject has a "myHexColor" property that you'd like to tween to red (<code>0xFF0000</code>) over the 
   course of 2 seconds, you'd do:<br /><br /><code>
    
    TweenMax.to(myObject, 2, new TweenMaxVars().hexColors({myHexColor:0xFF0000}));<br /><br /></code>
    
   You can pass in any number of hexColor properties. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br /><br />
   
     TweenMax.to(myObject, 2, new TweenMaxVars().hexColors({myHexColor:0xFF0000})); <br /><br /></code>
   
   Or if you just want to tween a color and apply it somewhere on every frame, you could do:<br /><br /><code>
   
   var myColor:Object = {hex:0xFF0000};<br />
   TweenMax.to(myColor, 2, new TweenMaxVars().hexColors({hex:0x0000FF}).onUpdate(applyColor));<br />
   function applyColor():void {<br />
     mc.graphics.clear();<br />
     mc.graphics.beginFill(myColor.hex, 1);<br />
     mc.graphics.drawRect(0, 0, 100, 100);<br />
     mc.graphics.endFill();<br />
   }<br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="immediateRender()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">immediateRender</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function immediateRender(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Normally when you create a tween, it begins rendering on the very next frame (when 
   the Flash Player dispatches an ENTER_FRAME event) unless you specify a <code>delay</code>. 
   This allows you to insert tweens into timelines and perform other actions that may affect 
   its timing. However, if you prefer to force the tween to render immediately when it is 
   created, set <code>immediateRender</code> to true. Or to prevent a tween with a duration of 
   zero from rendering immediately, set <code>immediateRender</code> to false. from() tweens
   render immediately by default as well, so to prevent that behavior, set <code>immediateRender</code>
   to false.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="motionBlur()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">motionBlur</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function motionBlur(strength:Number = 1, fastMode:Boolean = false, quality:int = 2, padding:int = 10):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   MotionBlurPlugin provides an easy way to apply a directional blur to a DisplayObject based on its velocity
   and angle of movement in 2D (x/y). This creates a much more realistic effect than a standard BlurFilter for
   several reasons:
   <ol>
     <li>A regular BlurFilter is limited to blurring horizontally and/or vertically whereas the motionBlur 
        gets applied at the angle at which the object is moving.</li>
   
     <li>A BlurFilter tween has static start/end values whereas a motionBlur tween dynamically adjusts the
      values on-the-fly during the tween based on the velocity of the object. So if you use a <code>Strong.easeInOut</code>
      for example, the strength of the blur will start out low, then increase as the object moves faster, and 
      reduce again towards the end of the tween.</li>
   </ol>
   
   motionBlur even works on bezier/bezierThrough tweens!<br /><br />
   
   To accomplish the effect, MotionBlurPlugin creates a Bitmap that it places over the original object, changing 
   alpha of the original to [almost] zero during the course of the tween. The original DisplayObject still follows the 
   course of the tween, so MouseEvents are properly dispatched. You shouldn't notice any loss of interactivity. 
   The DisplayObject can also have animated contents - MotionBlurPlugin automatically updates on every frame. 
   Be aware, however, that as with most filter effects, MotionBlurPlugin is somewhat CPU-intensive, so it is not 
   recommended that you tween large quantities of objects simultaneously. You can activate <code>fastMode</code>
   to significantly speed up rendering if the object's contents and size/color doesn't need to change during the
   course of the tween. <br /><br />
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">strength</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; Determines the strength of the blur. The default is 1. For a more powerful blur, increase the number. Or reduce it to make the effect more subtle.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">fastMode</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; Setting fastMode to <code>true</code> will significantly improve rendering performance but it is only appropriate for situations when the target object's contents,  size, color, filters, etc. do not need to change during the course of the tween. It works by essentially taking a BitmapData snapshot of the target object at the beginning of the tween and then reuses that throughout the tween, blurring it appropriately. The default value for <code>fastMode</code> is <code>false</code>.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">quality</span>:int</code> (default = <code>2</code>)<code></code> &mdash; The lower the quality, the less CPU-intensive the effect will be. Options are 1, 2, or 3. The default is 2.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">padding</span>:int</code> (default = <code>10</code>)<code></code> &mdash; padding controls the amount of space around the edges of the target object that is included in the BitmapData capture (the default is 10 pixels). If the target object has filters applied to it like a GlowFilter or DropShadowFilter that extend beyond the bounds of the object itself, you might need to increase the padding to accommodate the filters.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="move()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">move</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function move(x:Number, y:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "x" and "y" properties of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">x</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">y</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onComplete()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onComplete</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onComplete(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function that should be called when the tween has completed. 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function that should be called when the tween has completed. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onComplete function
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onCompleteListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onCompleteListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onCompleteListener(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> A function to which the TweenMax instance should dispatch a TweenEvent when it completes. This is the same as doing myTween.addEventListener(TweenEvent.COMPLETE, myFunction); </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onInit()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onInit</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onInit(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function that should be called just before the tween inits (renders for the first time).
   Since onInit runs before the start/end values are recorded internally, it is a good place to run
   code that affects the target's initial position or other tween-related properties. onStart, by
   contrast, runs AFTER the tween inits and the start/end values are recorded internally. onStart
   is called every time the tween begins which can happen more than once if the tween is restarted
   multiple times. 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function that should be called just before the tween inits (renders for the first time).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onInit function.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onRepeat()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onRepeat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onRepeat(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function that should be called every time the tween repeats 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function that should be called every time the tween repeats
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onRepeat function
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onReverseComplete()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onReverseComplete</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onReverseComplete(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function that should be called when the tween has reached its starting point again after having been reversed.  
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function that should be called when the tween has reached its starting point again after having been reversed.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onReverseComplete function
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onReverseCompleteListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onReverseCompleteListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onReverseCompleteListener(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>  A function to which the TweenMax instance should dispatch a TweenEvent when it has reached its starting point again after having been reversed </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onStart()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onStart</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onStart(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function that should be called when the tween begins (when its currentTime is at 0 
   and changes to some other value which can happen more than once if the tween is restarted multiple times). 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function that should be called when the tween begins.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onStart function.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onStartListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onStartListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onStartListener(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> A function to which the TweenMax instance should dispatch a TweenEvent when it begins. This is the same as doing <code>myTween.addEventListener(TweenEvent.START, myFunction);</code> </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onUpdate()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onUpdate</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onUpdate(func:Function, params:Array = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   A function to call whenever the tweening values are updated (on every frame during the time the tween is active). 
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code> &mdash; A function to call whenever the tweening values are updated. 
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">params</span>:Array</code> (default = <code>null</code>)<code></code> &mdash; An Array of parameters to pass the onUpdate function
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="onUpdateListener()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">onUpdateListener</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function onUpdateListener(func:Function):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values. This is the same as doing myTween.addEventListener(TweenEvent.UPDATE, myFunction); </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">func</span>:Function</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="orientToBezier()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">orientToBezier</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function orientToBezier(values:Object = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   A common effect that designers/developers want is for a MovieClip/Sprite to orient itself in the direction of 
   a Bezier path (alter its rotation). orientToBezier makes it easy. In order to alter a rotation property accurately, 
   TweenLite/Max needs 4 pieces of information:
   <ol>
     <li>Position property 1 (typically "x")</li>
     <li>Position property 2 (typically "y")</li>
     <li>Rotational property (typically "rotation")</li>
     <li>Number of degrees to add (optional - makes it easy to orient your MovieClip/Sprite properly)</li>
   </ol>
   
   The orientToBezier property should be an Array containing one Array for each set of these values. 
   For maximum flexibility, you can pass in any number of Arrays inside the container Array, one for 
   each rotational property. This can be convenient when working in 3D because you can rotate on multiple axis. 
   If you're doing a standard 2D x/y tween on a bezier, you can simply pass in a boolean value of true and 
   TweenMax will use a typical setup, <code>[["x", "y", "rotation", 0]]</code>. 
   Hint: Don't forget the container Array (notice the double outer brackets)<br /><br />
   
   To use the default value (<code>[["x", "y", "rotation", 0]]</code>), you can simply leave the values parameter as null. 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code> (default = <code>null</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="overwrite()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">overwrite</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function overwrite(value:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Controls how (and if) other tweens of the same target are overwritten by this tween; 
   NONE = 0, ALL_IMMEDIATE = 1, AUTO = 2, CONCURRENT = 3, ALL_ONSTART = 4, PREEXISTING = 5 
   (2 through 5 are only available with the optional OverwriteManager add-on class.</p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:int</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="paused()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">paused</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function paused(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Controls the paused state of the tween - if true, the tween will be paused initially. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="physics2D()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">physics2D</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function physics2D(velocity:Number, angle:Number, acceleration:Number = 0, accelerationAngle:Number = 90, friction:Number = 0):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Provides simple physics functionality for tweening a DisplayObject's x and y coordinates based on a
   combination of velocity, angle, gravity, acceleration, accelerationAngle, and/or friction. It is not intended
   to replace a full-blown physics engine and does not offer collision detection, but serves 
   as a way to easily create interesting physics-based effects with the GreenSock tweening platform. Parameters
   are not intended to be dynamically updateable, but one unique convenience is that everything is reverseable. 
   So if you spawn a bunch of particle tweens, for example, and throw them into a TimelineLite, you could
   simply call reverse() on the timeline to watch the particles retrace their steps right back to the beginning. 
   Keep in mind that any easing equation you define for your tween will be completely ignored for these properties.
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.Physics2DPlugin; <br />
     TweenPlugin.activate([Physics2DPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 2, new TweenMaxVars().physics2D(300, -60, 400)); <br /><br />
   </code>
   
   Physics2DPlugin is a Club GreenSock membership benefit. You must have a valid membership to use this class
   without violating the terms of use. Visit http://www.greensock.com/club/ to sign up or get more details.<br /><br />
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">velocity</span>:Number</code> &mdash; The initial velocity of the object measured in pixels per time unit (usually seconds, but for tweens where useFrames is true, it would be measured in frames). The default is zero.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">angle</span>:Number</code> &mdash; The initial angle (in degrees) at which the object is traveling. Only pertinent when a velocity is defined. For example, if the object should start out traveling at -60 degrees (towards the upper right), the angle would be -60. The default is zero.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">acceleration</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; The amount of acceleration applied to the object, measured in pixels per time unit (usually seconds, but for tweens where useFrames is true, it would be measured in frames). To apply the acceleration in a specific direction that is different than the <code>angle</code>, use the <code>accelerationAngle</code> property.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">accelerationAngle</span>:Number</code> (default = <code>90</code>)<code></code> &mdash; The angle at which acceleration is applied (if any), measured in degrees. So if, for example, you want the object to accelerate towards the left side of the screen, you'd use an <code>accelerationAngle</code> of 180.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">friction</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; A value between 0 and 1 where 0 is no friction, 0.08 is a small amount of friction, and 1 will completely prevent any movement. This is not meant to be precise or scientific in any way, but rather serves as an easy way to apply a friction-like physics effect to your tween. Generally it is best to experiment with this number a bit. Also note that friction requires more processing than physics tweens without any friction.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#physicsProps()" target="">physicsProps()</a>
</div>
</div>
<a name="physicsProps()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">physicsProps</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function physicsProps(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Sometimes you want to tween a property (or several) but you don't have a specific end value in mind - instead,
   you'd rather describe the movement in terms of physics concepts, like velocity, acceleration, 
   and/or friction. physicsProps allows you to tween any numeric property of any object based
   on these concepts. Keep in mind that any easing equation you define for your tween will be completely
   ignored for these properties. Instead, the physics parameters will determine the movement/easing.
   These parameters, by the way, are not intended to be dynamically updateable, but one unique convenience 
   is that everything is reverseable. So if you create several physics-based tweens, for example, and 
   throw them into a TimelineLite, you could simply call reverse() on the timeline to watch the objects 
   retrace their steps right back to the beginning. Here are the parameters you can define (note that 
   friction and acceleration are both completely optional):
   <ul>
     <li><b>velocity : Number</b> - the initial velocity of the object measured in units per time 
           unit (usually seconds, but for tweens where useFrames is true, it would 
           be measured in frames). The default is zero.</li>
     <li><b>acceleration : Number</b> [optional] - the amount of acceleration applied to the object, measured
           in units per time unit (usually seconds, but for tweens where useFrames 
           is true, it would be measured in frames). The default is zero.</li>
     <li><b>friction : Number</b> [optional] - a value between 0 and 1 where 0 is no friction, 0.08 is a small amount of
           friction, and 1 will completely prevent any movement. This is not meant to be precise or 
           scientific in any way, but rather serves as an easy way to apply a friction-like
           physics effect to your tween. Generally it is best to experiment with this number a bit.
           Also note that friction requires more processing than physics tweens without any friction.</li>
    </ul>
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.PhysicsPropsPlugin; <br />
     TweenPlugin.activate([PhysicsPropsPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 2, new TweenMaxVars().physicsProps({<br />
             x:{velocity:100, acceleration:200},<br />
             y:{velocity:-200, friction:0.1}<br />
             }<br />
          )); <br /><br />
    </code>
   
   PhysicsPropsPlugin is a Club GreenSock membership benefit. You must have a valid membership to use this class
   without violating the terms of use. Visit http://www.greensock.com/club/ to sign up or get more details.<br /><br />
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#physics2D()" target="">physics2D()</a>
</div>
</div>
<a name="prop()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">prop</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function prop(property:String, value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Adds a dynamic property for tweening and allows you to indicate whether the value is relative or not.
   For example, to tween "x" to 50 less than whatever it currently is:<br /><br />
   
   <code>prop("x", -50, true);</code>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">property</span>:String</code> &mdash; Property name
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code> &mdash; Numeric end value (or beginning value for <code>from()</code> tweens)
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code> &mdash; If <code>true</code>, the value will be interpreted as relative to the target's current value. For example, if mc.x is currently 300 and you do <code>prop("x", 200, true)</code>, the end value will be 500.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="quaternions()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">quaternions</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function quaternions(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> An object with properties that correspond to the quaternion properties of the target object. For example, if your my3DObject has "orientation" and "childOrientation" properties that contain quaternions, and you'd like to tween them both, you'd do: {orientation:myTargetQuaternion1, childOrientation:myTargetQuaternion2}. Quaternions must have the following properties: x, y, z, and w. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="removeTint()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeTint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeTint(remove:Boolean = true):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Removes the tint of a DisplayObject over time. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">remove</span>:Boolean</code> (default = <code>true</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="repeat()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">repeat</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function repeat(value:int):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Number of times that the tween should repeat (to repeat indefinitely, use -1). </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:int</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="repeatDelay()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">repeatDelay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function repeatDelay(value:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Amount of time in seconds (or frames for frames-based tween) between repeats. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="reversed()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">reversed</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function reversed(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   If true, the tween will be reversed initially. This does not swap the starting/ending
   values in the tween - it literally changes its orientation/direction. Imagine the playhead
   moving backwards instead of forwards. This does NOT force it to the very end and start 
   playing backwards. It simply affects the orientation of the tween, so if reversed is set to 
   true initially, it will appear not to play because it is already at the beginning. To cause it to
   play backwards from the end, set reversed to true and then set the <code>currentProgress</code> 
   property to 1 immediately after creating the tween (or set the currentTime to the duration).
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="rotation()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">rotation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function rotation(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "rotation" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="roundProps()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">roundProps</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function roundProps(propertyNames:Array):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> An array of the names of properties that should be rounded to the nearest integer when tweening. For example, <code>["x","y"]</code> </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">propertyNames</span>:Array</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="runBackwards()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">runBackwards</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function runBackwards(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> When true, the tween will flip the start and end values which is exactly what <code>TweenMax.from()</code> does. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="scale()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scale</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function scale(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "scaleX" and "scaleY" properties of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="scaleX()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleX</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function scaleX(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "scaleX" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="scaleY()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scaleY</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function scaleY(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "scaleY" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="scrollRect()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">scrollRect</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function scrollRect(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Tweens the scrollRect property of a DisplayObject. You can define any (or all) of the following properties:
   <code>
   <ul>
     <li> x : Number</li>
     <li> y : Number</li>
     <li> width : Number</li>
     <li> height : Number</li>
     <li> top : Number</li>
     <li> bottom : Number</li>
     <li> left : Number</li>
     <li> right : Number</li>
   </ul>
   </code><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.ScrollRectPlugin; <br />
     TweenPlugin.activate([ScrollRectPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().scrollRect({x:50, y:300, width:100, height:100})); <br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="setSize()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">setSize</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function setSize(width:Number, height:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Some components require resizing with setSize() instead of standard tweens of width/height in
   order to scale properly. The SetSizePlugin accommodates this easily. You can define the width, 
   height, or both. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.SetSizePlugin; <br />
     TweenPlugin.activate([SetSizePlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(myComponent, 1, new TweenMaxVars().setSize(200, 30)); <br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">width</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">height</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="shortRotation()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">shortRotation</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function shortRotation(values:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   To tween any rotation property of the target object in the shortest direction, use "shortRotation" 
   For example, if <code>myObject.rotation</code> is currently 170 degrees and you want to tween it to 
   -170 degrees, a normal rotation tween would travel a total of 340 degrees in the counter-clockwise 
   direction, but if you use shortRotation, it would travel 20 degrees in the clockwise direction instead. 
   You can define any number of rotation properties in the shortRotation object which makes 3D tweening
   easier, like:<br /><br /><code> 
     
     TweenMax.to(mc, 2, new TweenMaxVars().shortRotation({rotationX:-170, rotationY:35, rotationZ:200})); <br /><br /></code>
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.ShortRotationPlugin; <br />
     TweenPlugin.activate([ShortRotationPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().shortRotation({rotation:-170}));<br /><br />
   
     //or for a 3D tween with multiple rotation values...<br />
     TweenMax.to(mc, 1, new TweenMaxVars().shortRotation({rotationX:-170, rotationY:35, rotationZ:10})); <br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">values</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="soundTransform()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">soundTransform</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function soundTransform(volume:Number = 1, pan:Number = 0, leftToLeft:Number = 1, leftToRight:Number = 0, rightToLeft:Number = 0, rightToRight:Number = 1):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Tweens properties of an object's soundTransform property (like the volume, pan, leftToRight, etc. 
   of a MovieClip/SoundChannel/NetStream). <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.SoundTransformPlugin; <br />
     TweenPlugin.activate([SoundTransformPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().soundTransform(0.2, 0.5)); <br /><br />
   </code>
    
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">volume</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; The volume, ranging from 0 (silent) to 1 (full volume).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">pan</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; The left-to-right panning of the sound, ranging from -1 (full pan left) to 1 (full pan right).
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">leftToLeft</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the left speaker.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">leftToRight</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; A value, from 0 (none) to 1 (all), specifying how much of the left input is played in the right speaker.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rightToLeft</span>:Number</code> (default = <code>0</code>)<code></code> &mdash; A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the left speaker.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">rightToRight</span>:Number</code> (default = <code>1</code>)<code></code> &mdash; A value, from 0 (none) to 1 (all), specifying how much of the right input is played in the right speaker.
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="stageQuality()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">stageQuality</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function stageQuality(stage:Stage, during:String = "medium", after:String = null):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   Sets the stage's <code>quality</code> to a particular value during a tween and another value after
   the tween which can be useful for improving rendering performance in the Flash Player while things are animating.<br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.StageQualityPlugin; <br />
     import flash.display.StageQuality; <br />
     TweenPlugin.activate([StageQualityPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().prop("x", 100).stageQuality(this.stage, StageQuality.LOW, StageQuality.HIGH)); <br /><br />
   </code>
   
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">stage</span>:Stage</code> &mdash; A reference to the stage
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">during</span>:String</code> (default = "<code>medium</code>")<code></code> &mdash; The stage quality that should be used during the tween
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">after</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The stage quality that should be set after the tween completes
   </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code> &mdash; 
                        The TweenMaxVars instance
   
                        
                     </td>
</tr>
</table>
</div>
<a name="startAt()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">startAt</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function startAt(vars:<a href="TweenMaxVars.html">TweenMaxVars</a>):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Allows you to define the starting values for properties. It is the same as defining the "from" parameter in a <code>TweenMax.fromTo()</code> call. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">vars</span>:<a href="TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="throwProps()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">throwProps</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function throwProps(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
  Allows you to define an initial velocity at which a property (or multiple properties) will start tweening, 
  as well as [optional] maximum and/or minimum end values and then it will calculate the appropriate landing 
  position and plot a smooth course to it based on the easing equation you define (Quad.easeOut by default, 
  as set in TweenLite). This is perfect for flick-scrolling or animating things as though they are being thrown.<br /><br />
  
  In its simplest form, you can pass just the initial velocity for each property like this:<br /><br /><code>
  {x:500, y:-300}</code><br /><br />
  
  In the above example, <code>x</code> will animate at 500 pixels per second initially and 
  <code>y</code> will animate at -300 pixels per second. Both will decelerate smoothly 
  until they come to rest based on the tween's duration. <br /><br /> 
  
  To impose maximum and minimum boundaries on the end values, use the nested object syntax 
  with the <code>max</code> and <code>min</code> special properties like this:<br /><br /><code>
  {x:{velocity:500, max:1024, min:0}, y:{velocity:-300, max:720, min:0}};
  </code><br /><br />
  
  Notice the nesting of the objects ({}). The <code>max</code> and <code>min</code> values refer
  to the range for the final resting position (coordinates in this case), NOT the velocity. 
  So <code>x</code> would always land between 0 and 1024 in this case, and <code>y</code> 
  would always land between 0 and 720. If you want the target object to land on a specific value 
  rather than within a range, simply set <code>max</code> and <code>min</code> to identical values. 
  Also notice that you must define a <code>velocity</code> value for each property in the object syntax.<br /><br />
  
  <code>throwProps</code> isn't just for tweening x and y coordinates. It works with any numeric 
  property, so you could use it for spinning the <code>rotation</code> of an object as well. Or the 
  <code>scaleX</code>/<code>scaleY</code> properties. Maybe the user drags to spin a wheel and
  lets go and you want it to continue increasing the <code>rotation</code> at that velocity, 
  decelerating smoothly until it stops.<br /><br />
  
  ThrowPropsPlugin is a <a href="http://www.greensock.com/club/">Club GreenSock</a> membership benefit. 
  You must have a valid membership to use this class without violating the terms of use. Visit 
  <a href="http://www.greensock.com/club/">http://www.greensock.com/club/</a> to sign up or get more details.<br /><br />
  </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="timeScale()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">timeScale</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function timeScale(value:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Multiplier affecting the speed of the timeline where 1 is normal speed, 0.5 is half-speed, 2 is double speed, etc. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="tint()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">tint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function tint(color:uint):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   To change a DisplayObject's tint, set this to the hex value of the color you'd like the DisplayObject 
   to end up at (or begin at if you're using TweenMax.from()). An example hex value would be 0xFF0000. 
   If you'd like to remove the tint from a DisplayObject, use the removeTint special property. 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">color</span>:uint</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#removeTint()" target="">removeTint()</a>
<br>
<a href="../data/TweenMaxVars.html#colorMatrixFilter()" target="">colorMatrixFilter()</a>
<br>
<a href="../data/TweenMaxVars.html#colorTransform()" target="">colorTransform()</a>
</div>
</div>
<a name="transformAroundCenter()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">transformAroundCenter</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function transformAroundCenter(props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration
   point (most often its upper left corner), but TransformAroundCenter allows you to make the transformations
   occur around the DisplayObject's center. 
   
   If you define an x or y value in the transformAroundCenter object, it will correspond to the center which 
   makes it easy to position (as opposed to having to figure out where the original registration point 
   should tween to). If you prefer to define the x/y in relation to the original registration point, do so outside 
   the transformAroundCenter object, like: <br /><br /><code>
   
   TweenMax.to(mc, 3, new TweenMaxVars().prop("x", 50).prop("y", 40).transformAroundCenter({scale:0.5, rotation:30}));<br /><br /></code>
   
   TransformAroundCenterPlugin is a <a href="http://www.greensock.com/club/">Club GreenSock</a> membership benefit. 
   You must have a valid membership to use this class without violating the terms of use. Visit 
   <a href="http://blog.greensock.com/club/">http://www.greensock.com/club/</a> to sign up or get more details. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.TransformAroundCenterPlugin; <br />
     TweenPlugin.activate([TransformAroundCenterPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().transformAroundCenter({scale:1.5, rotation:150})); <br /><br />
   </code> 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#transformAroundPoint()" target="">transformAroundPoint()</a>
</div>
</div>
<a name="transformAroundPoint()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">transformAroundPoint</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function transformAroundPoint(point:Point, props:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Normally, all transformations (scale, rotation, and position) are based on the DisplayObject's registration
   point (most often its upper left corner), but TransformAroundPoint allows you to define ANY point around which
   transformations will occur during the tween. For example, you may have a dynamically-loaded image that you 
   want to scale from its center or rotate around a particular point on the stage. <br /><br />
   
   If you define an x or y value in the transformAroundPoint object, it will correspond to the custom registration
   point which makes it easy to position (as opposed to having to figure out where the original registration point 
   should tween to). If you prefer to define the x/y in relation to the original registration point, do so outside 
   the transformAroundPoint object, like: <br /><br /><code>
   
   TweenMax.to(mc, 3, new TweenMaxVars().prop("x", 50).prop("y", 40).transformAroundPoint(new Point(200, 300), {scale:0.5, rotation:30}));<br /><br /></code>
   
   TransformAroundPointPlugin is a <a href="http://www.greensock.com/club/">Club GreenSock</a> membership benefit. 
   You must have a valid membership to use this class without violating the terms of use. Visit 
   <a href="http://www.greensock.com/club/">http://www.greensock.com/club/</a> to sign up or get more details. <br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.TransformAroundPointPlugin; <br />
     TweenPlugin.activate([TransformAroundPointPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().transformAroundPoint(new Point(100, 300), {scaleX:2, scaleY:1.5, rotation:150})); <br /><br />
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">point</span>:Point</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">props</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
<p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="../data/TweenMaxVars.html#transformAroundCenter()" target="">transformAroundCenter()</a>
</div>
</div>
<a name="transformMatrix()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">transformMatrix</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function transformMatrix(properties:Object):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p>
   transformMatrix tweens a DisplayObject's transform.matrix values directly either using
   the standard matrix properties (<code>a, b, c, d, tx, and ty</code>) or common properties 
   like <code>x, y, scaleX, scaleY, skewX, skewY, rotation</code> and even <code>shortRotation</code>.
   To skew without adjusting scale visually, use skewX2 and skewY2 instead of skewX and skewY. 
   <br /><br />
   
   transformMatrix tween will affect all of the DisplayObject's transform properties, so do not use
   it in conjunction with regular x/y/scaleX/scaleY/rotation tweens concurrently.<br /><br />
   
   <b>USAGE:</b><br /><br />
   <code>
     import com.greensock.TweenMax; <br />
     import com.greensock.data.TweenMaxVars; <br />
     import com.greensock.plugins.TweenPlugin; <br />
     import com.greensock.plugins.TransformMatrixPlugin; <br />
     TweenPlugin.activate([TransformMatrixPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().transformMatrix({x:50, y:300, scaleX:2, scaleY:2})); <br /><br />
     
     //-OR-<br /><br />
   
     TweenMax.to(mc, 1, new TweenMaxVars().transformMatrix({tx:50, ty:300, a:2, d:2})); <br /><br />
   
   </code>
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">properties</span>:Object</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="useFrames()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">useFrames</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function useFrames(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   If <code>useFrames</code> is set to true, the tweens's timing mode will be based on frames. 
   Otherwise, it will be based on seconds/time. <b>NOTE:</b> a tween's timing mode is always 
   determined by its parent timeline. 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="visible()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">visible</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function visible(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Sets a DisplayObject's "visible" property at the end of the tween. </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="volume()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">volume</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function volume(volume:Number):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Changes the volume of any object that has a soundTransform property (MovieClip, SoundChannel, NetStream, etc.) </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">volume</span>:Number</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="width()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">width</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function width(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "width" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="x()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">x</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function x(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "x" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="y()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">y</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function y(value:Number, relative:Boolean = false):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> Tweens the "y" property of the target </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Number</code></td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">relative</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<a name="yoyo()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">yoyo</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function yoyo(value:Boolean):<a href="../data/TweenMaxVars.html">TweenMaxVars</a></code><p> 
   Works in conjunction with the <code>repeat</code> property, determining the behavior of each 
   cycle. When yoyo is true, the tween will go back and forth, appearing to reverse 
   every other cycle (this has no affect on the "reversed" property though). So if repeat is
   2 and yoyo is false, it will look like: start - 1 - 2 - 3 - 1 - 2 - 3 - 1 - 2 - 3 - end. But 
   if repeat is 2 and yoyo is true, it will look like: start - 1 - 2 - 3 - 3 - 2 - 1 - 1 - 2 - 3 - end.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">value</span>:Boolean</code></td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../data/TweenMaxVars.html">TweenMaxVars</a></code></td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
